<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: VaadinApplication.html 966 2015-01-28 18:06:10Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.server.SessionDestroyListener;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.vaadin.server.VaadinSession;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.io.IOException;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.io.ObjectInputStream;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.io.Serializable;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.concurrent.Future;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.slf4j.Logger;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.slf4j.LoggerFactory;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * A globally accessible "Vaadin application" singleton.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * At most one instance is associated with each {@link VaadinSession} (attempting to create more than one will result in<a name="line.25"></a>
<span class="sourceLineNo">026</span> * an exception). This singleton instance is then always accessible from any Vaadin thread via {@link #get()}.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;/p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Although this class does not require Spring, the singleton instance can be declared as a bean in the Spring XML<a name="line.30"></a>
<span class="sourceLineNo">031</span> * application context created by a {@link SpringVaadinSessionListener}, which allows other beans and widgets<a name="line.31"></a>
<span class="sourceLineNo">032</span> * in the Vaadin application context to autowire it and have access to the methods provided here:<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *  &amp;lt;bean class="org.dellroad.stuff.vaadin7.VaadinApplication"/&amp;gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * If your {@link VaadinApplication} instance allocates any resources on startup, be sure to configure it so<a name="line.36"></a>
<span class="sourceLineNo">037</span> * that it cleans them up on application context shutdown, for example, by specifying {@code destroy-method="..."}.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * If you are in a clustered environment and are subclassing this class, {@code scope="session"} is recommended;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * without it, there will be one instance per server+session rather than one unique instance per session. Of course,<a name="line.42"></a>
<span class="sourceLineNo">043</span> * whether that matters depends on the semantics of the subclass fields. In any case, be aware that no instance will<a name="line.43"></a>
<span class="sourceLineNo">044</span> * exist in session until the application context is refreshed.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Note: using {@code scope="session"} requires adding a {@code &lt;listener&gt;} clause registering Spring's<a name="line.48"></a>
<span class="sourceLineNo">049</span> * {@link org.springframework.web.context.request.RequestContextListener} in your {@code web.xml}.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;/p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;p&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * If this class is subclassed, additional application-specific fields and methods can be supplied to the entire<a name="line.53"></a>
<span class="sourceLineNo">054</span> * application via the same mechanism. Subclasses can override {@link #init} for any application-specific initialization.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;/p&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Note: the singleton instance of this class is stored in the Vaadin session and is {@link Serializable}. Therefore,<a name="line.58"></a>
<span class="sourceLineNo">059</span> * in a clustered environment, subclasses must be prepared to handle (de)serialization. Also, avoid declaring fields<a name="line.59"></a>
<span class="sourceLineNo">060</span> * that reference this class in non-session-scope beans; instead, use {@link #get VaadinApplication.get()}.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;/p&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @see SpringVaadinServlet<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @see SpringVaadinSessionListener<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @see com.vaadin.server.VaadinService<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span>public class VaadinApplication implements Serializable {<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    private static final long serialVersionUID = -4202507689739224846L;<a name="line.69"></a>
<span class="sourceLineNo">070</span>    private static final Class&lt;VaadinApplication&gt; ATTRIBUTE_KEY = VaadinApplication.class;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    protected final Logger log = LoggerFactory.getLogger(this.getClass());<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    private transient VaadinSession session;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    /**<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * Convenience constructor. Equivalent to:<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * &lt;blockquote&gt;&lt;/code&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *  {@link #VaadinApplication(VaadinSession) VaadinApplication}({@link VaadinUtil#getCurrentSession})<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * &lt;/code&gt;&lt;/blockquote&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @throws IllegalStateException if there is no {@link VaadinSession} associated with the current thread<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @throws IllegalStateException if there is already a {@link VaadinApplication} instance associated with the current session<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    public VaadinApplication() {<a name="line.85"></a>
<span class="sourceLineNo">086</span>        this(VaadinUtil.getCurrentSession());<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Primary Constructor.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @param session the session with which this instance should be associated<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @throws IllegalArgumentException if {@code session} is null<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @throws IllegalStateException if there is already a {@link VaadinApplication} instance associated with {@code session}<a name="line.94"></a>
<span class="sourceLineNo">095</span>     */<a name="line.95"></a>
<span class="sourceLineNo">096</span>    public VaadinApplication(VaadinSession session) {<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>        // Get session<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if (session == null)<a name="line.99"></a>
<span class="sourceLineNo">100</span>            throw new IllegalArgumentException("null session");<a name="line.100"></a>
<span class="sourceLineNo">101</span>        this.session = session;<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>        // Check for already-existing instance<a name="line.103"></a>
<span class="sourceLineNo">104</span>        VaadinApplication vaadinApplication = this.session.getAttribute(ATTRIBUTE_KEY);<a name="line.104"></a>
<span class="sourceLineNo">105</span>        if (vaadinApplication != null) {<a name="line.105"></a>
<span class="sourceLineNo">106</span>            throw new IllegalStateException("there is already a VaadinApplication associated with VaadinSession "<a name="line.106"></a>
<span class="sourceLineNo">107</span>              + this.session + ": " + vaadinApplication + "; did you accidentally declare more than one instance of"<a name="line.107"></a>
<span class="sourceLineNo">108</span>              + " VaadinApplication in the Vaadin Spring XML application context?");<a name="line.108"></a>
<span class="sourceLineNo">109</span>        }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span>        // Set session attribute<a name="line.111"></a>
<span class="sourceLineNo">112</span>        VaadinApplication.setAttribute(this.session, ATTRIBUTE_KEY, this);<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span>        // Delegate to subclass for further initialization<a name="line.114"></a>
<span class="sourceLineNo">115</span>        this.init();<a name="line.115"></a>
<span class="sourceLineNo">116</span>    }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>    /**<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * Perform any further initialization at construction time.<a name="line.119"></a>
<span class="sourceLineNo">120</span>     *<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * &lt;p&gt;<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * The implementation in {@link VaadinApplication} does nothing. Subclasses may override as desired.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * &lt;/p&gt;<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    protected void init() {<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * Get the {@link VaadinSession} associated with this instance.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     *<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * @return associated VaadinSession, never null<a name="line.131"></a>
<span class="sourceLineNo">132</span>     */<a name="line.132"></a>
<span class="sourceLineNo">133</span>    public VaadinSession getSession() {<a name="line.133"></a>
<span class="sourceLineNo">134</span>        return this.session;<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * Close the {@link VaadinSession} associated with this instance.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * After invoking this method, the caller would normally ensure that no further references to this<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * instance remain so that it and the associated {@link VaadinSession} can be freed.<a name="line.140"></a>
<span class="sourceLineNo">141</span>     *<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * &lt;p&gt;<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * The implementation in {@link VaadinApplication} just delegates to {@link com.vaadin.server.VaadinSession#close}.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     */<a name="line.144"></a>
<span class="sourceLineNo">145</span>    public void close() {<a name="line.145"></a>
<span class="sourceLineNo">146</span>        this.session.close();<a name="line.146"></a>
<span class="sourceLineNo">147</span>    }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span>    /**<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * Get the singleton {@link VaadinApplication} instance associated with the current {@link VaadinSession}.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     *<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * &lt;p&gt;<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * This is a convenience method, equivalent to:<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * &lt;blockquote&gt;&lt;code&gt;<a name="line.154"></a>
<span class="sourceLineNo">155</span>     *  {@link #get(Class) VaadinApplication.get}({@link VaadinApplication VaadinApplication.class})<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * &lt;/code&gt;&lt;/blockquote&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span>     *<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * @return singleton instance for the current Vaadin application, never null<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @throws IllegalStateException if there is no {@link VaadinSession} associated with the current thread<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * @throws IllegalStateException if there is no {@link VaadinApplication} instance associated with the current session<a name="line.160"></a>
<span class="sourceLineNo">161</span>     */<a name="line.161"></a>
<span class="sourceLineNo">162</span>    public static VaadinApplication get() {<a name="line.162"></a>
<span class="sourceLineNo">163</span>        return VaadinApplication.get(VaadinApplication.class);<a name="line.163"></a>
<span class="sourceLineNo">164</span>    }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span>    /**<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * Get the singleton instance of the specified class associated with the current {@link VaadinSession}.<a name="line.167"></a>
<span class="sourceLineNo">168</span>     *<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * &lt;p&gt;<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * This is a convenience method, equivalent to:<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * &lt;blockquote&gt;&lt;code&gt;<a name="line.171"></a>
<span class="sourceLineNo">172</span>     *  {@link #get(Class) VaadinApplication.get}({@link VaadinUtil#getCurrentSession}, clazz)<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * &lt;/code&gt;&lt;/blockquote&gt;<a name="line.173"></a>
<span class="sourceLineNo">174</span>     *<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * &lt;p&gt;<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * Useful for subclasses of {@link VaadinApplication} that want to provide their own zero-parameter {@code get()} methods.<a name="line.176"></a>
<span class="sourceLineNo">177</span>     *<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * @param clazz singleton instance type<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * @return singleton instance of {@code clazz} in the session, never null<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * @throws IllegalArgumentException if {@code clazz} is null<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * @throws IllegalStateException if there is no {@link VaadinSession} associated with the current thread<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @throws IllegalStateException if there is no singleton of type {@code clazz} associated with the current session<a name="line.182"></a>
<span class="sourceLineNo">183</span>     */<a name="line.183"></a>
<span class="sourceLineNo">184</span>    public static &lt;T extends VaadinApplication&gt; T get(Class&lt;T&gt; clazz) {<a name="line.184"></a>
<span class="sourceLineNo">185</span>        return VaadinApplication.get(VaadinUtil.getCurrentSession(), clazz);<a name="line.185"></a>
<span class="sourceLineNo">186</span>    }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span>    /**<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * Get the singleton instance of the specified class associated with the given session.<a name="line.189"></a>
<span class="sourceLineNo">190</span>     *<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * @param session Vaadin session<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * @param clazz singleton instance type<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * @return singleton instance of {@code clazz} in the session, never null<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * @throws IllegalArgumentException if {@code session} is null<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * @throws IllegalArgumentException if {@code clazz} is null<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * @throws IllegalStateException if there is no singleton of type {@code clazz} associated with the {@code session}<a name="line.196"></a>
<span class="sourceLineNo">197</span>     */<a name="line.197"></a>
<span class="sourceLineNo">198</span>    public static &lt;T extends VaadinApplication&gt; T get(VaadinSession session, Class&lt;T&gt; clazz) {<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span>        // Sanity check<a name="line.200"></a>
<span class="sourceLineNo">201</span>        if (session == null)<a name="line.201"></a>
<span class="sourceLineNo">202</span>            throw new IllegalArgumentException("null session");<a name="line.202"></a>
<span class="sourceLineNo">203</span>        if (clazz == null)<a name="line.203"></a>
<span class="sourceLineNo">204</span>            throw new IllegalArgumentException("null clazz");<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>        // Get the application<a name="line.206"></a>
<span class="sourceLineNo">207</span>        VaadinApplication vaadinApplication = session.getAttribute(ATTRIBUTE_KEY);<a name="line.207"></a>
<span class="sourceLineNo">208</span>        if (vaadinApplication == null) {<a name="line.208"></a>
<span class="sourceLineNo">209</span>            throw new IllegalStateException("there is no VaadinApplication associated with the current VaadinSession"<a name="line.209"></a>
<span class="sourceLineNo">210</span>              + "; did you declare an instance of VaadinApplication in the Vaadin Spring XML application context?"<a name="line.210"></a>
<span class="sourceLineNo">211</span>              + " And if declared scope=\"session\", did you register Spring's RequestContextListener in web.xml?");<a name="line.211"></a>
<span class="sourceLineNo">212</span>        }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span>        // Check type<a name="line.214"></a>
<span class="sourceLineNo">215</span>        if (!clazz.isInstance(vaadinApplication)) {<a name="line.215"></a>
<span class="sourceLineNo">216</span>            throw new IllegalStateException("there is a VaadinApplication associated with the current VaadinSession"<a name="line.216"></a>
<span class="sourceLineNo">217</span>              + " but it is not an instance of " + clazz + "; instead it has type " + vaadinApplication.getClass().getName());<a name="line.217"></a>
<span class="sourceLineNo">218</span>        }<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span>        // Done<a name="line.220"></a>
<span class="sourceLineNo">221</span>        return clazz.cast(vaadinApplication);<a name="line.221"></a>
<span class="sourceLineNo">222</span>    }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span>    /**<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * Peform some action while holding the lock of the {@link VaadinSession} associated with this instance.<a name="line.225"></a>
<span class="sourceLineNo">226</span>     *<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * &lt;p&gt;<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * This is a convenience method that in turn invokes {@link VaadinUtil#invoke VaadinUtil.invoke()} using the<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * {@link VaadinSession} associated with this instance.<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * &lt;/p&gt;<a name="line.230"></a>
<span class="sourceLineNo">231</span>     *<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * @param action action to perform<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * @throws IllegalArgumentException if {@code action} is null<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * @see VaadinUtil#invoke<a name="line.234"></a>
<span class="sourceLineNo">235</span>     */<a name="line.235"></a>
<span class="sourceLineNo">236</span>    public void invoke(Runnable action) {<a name="line.236"></a>
<span class="sourceLineNo">237</span>        VaadinUtil.invoke(this.session, action);<a name="line.237"></a>
<span class="sourceLineNo">238</span>    }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span>    /**<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * Peform some action asynchronously while holding the lock of the {@link VaadinSession} associated with this instance.<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * &lt;p&gt;<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * This is a convenience method that in turn invokes {@link VaadinUtil#invokeLater VaadinUtil.invokeLater()} using the<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * {@link VaadinSession} associated with this instance.<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * &lt;/p&gt;<a name="line.246"></a>
<span class="sourceLineNo">247</span>     *<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * @param action action to perform<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * @throws IllegalArgumentException if {@code action} is null<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * @see VaadinUtil#invokeLater<a name="line.250"></a>
<span class="sourceLineNo">251</span>     */<a name="line.251"></a>
<span class="sourceLineNo">252</span>    public Future&lt;Void&gt; invokeLater(Runnable action) {<a name="line.252"></a>
<span class="sourceLineNo">253</span>        return VaadinUtil.invokeLater(this.session, action);<a name="line.253"></a>
<span class="sourceLineNo">254</span>    }<a name="line.254"></a>
<span class="sourceLineNo">255</span><a name="line.255"></a>
<span class="sourceLineNo">256</span>    /**<a name="line.256"></a>
<span class="sourceLineNo">257</span>     * Register for a notification when the {@link VaadinSession} is closed, without creating a memory leak.<a name="line.257"></a>
<span class="sourceLineNo">258</span>     *<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * &lt;p&gt;<a name="line.259"></a>
<span class="sourceLineNo">260</span>     * This is a convenience method that in turn invokes<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * {@link VaadinUtil#addSessionDestroyListener VaadinUtil.addSessionDestroyListener()} using the<a name="line.261"></a>
<span class="sourceLineNo">262</span>     * {@link VaadinSession} associated with this instance.<a name="line.262"></a>
<span class="sourceLineNo">263</span>     *<a name="line.263"></a>
<span class="sourceLineNo">264</span>     * @throws IllegalArgumentException if {@code listener} is null<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * @see VaadinUtil#addSessionDestroyListener<a name="line.265"></a>
<span class="sourceLineNo">266</span>     */<a name="line.266"></a>
<span class="sourceLineNo">267</span>    public void addSessionDestroyListener(SessionDestroyListener listener) {<a name="line.267"></a>
<span class="sourceLineNo">268</span>        VaadinUtil.addSessionDestroyListener(this.session, listener);<a name="line.268"></a>
<span class="sourceLineNo">269</span>    }<a name="line.269"></a>
<span class="sourceLineNo">270</span><a name="line.270"></a>
<span class="sourceLineNo">271</span>    /**<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * Remove a listener added via {@link #addSessionDestroyListener addSessionDestroyListener()}.<a name="line.272"></a>
<span class="sourceLineNo">273</span>     *<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * &lt;p&gt;<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * This is a convenience method that in turn invokes<a name="line.275"></a>
<span class="sourceLineNo">276</span>     * {@link VaadinUtil#removeSessionDestroyListener VaadinUtil.removeSessionDestroyListener()} using the<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * {@link VaadinSession} associated with this instance.<a name="line.277"></a>
<span class="sourceLineNo">278</span>     *<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * @throws IllegalArgumentException if {@code listener} is null<a name="line.279"></a>
<span class="sourceLineNo">280</span>     * @see VaadinUtil#removeSessionDestroyListener<a name="line.280"></a>
<span class="sourceLineNo">281</span>     */<a name="line.281"></a>
<span class="sourceLineNo">282</span>    public void removeSessionDestroyListener(SessionDestroyListener listener) {<a name="line.282"></a>
<span class="sourceLineNo">283</span>        VaadinUtil.removeSessionDestroyListener(this.session, listener);<a name="line.283"></a>
<span class="sourceLineNo">284</span>    }<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span>    // This method exists solely to bind the generic type<a name="line.286"></a>
<span class="sourceLineNo">287</span>    private static &lt;T&gt; void setAttribute(VaadinSession session, Class&lt;T&gt; clazz, Object value) {<a name="line.287"></a>
<span class="sourceLineNo">288</span>        session.setAttribute(clazz, clazz.cast(value));<a name="line.288"></a>
<span class="sourceLineNo">289</span>    }<a name="line.289"></a>
<span class="sourceLineNo">290</span><a name="line.290"></a>
<span class="sourceLineNo">291</span>// Serialization<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span>    private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {<a name="line.293"></a>
<span class="sourceLineNo">294</span>        input.defaultReadObject();<a name="line.294"></a>
<span class="sourceLineNo">295</span>        this.session = VaadinUtil.getCurrentSession();<a name="line.295"></a>
<span class="sourceLineNo">296</span>    }<a name="line.296"></a>
<span class="sourceLineNo">297</span>}<a name="line.297"></a>
<span class="sourceLineNo">298</span><a name="line.298"></a>




























































</pre>
</div>
</body>
</html>
